chore: Update SETUP.md to include part about format on save #1306
Conversation
✅ Deploy Preview for veda-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
AliceR
changed the title
AliceR
changed the title
| Ensure ESLint is set as the default formatter: | ||
| ```json | ||
| "editor.defaultFormatter": "dbaeumer.vscode-eslint" | ||
| ``` |
There was a problem hiding this comment.
was able to sortof follow.. following step 2, couldn't figure out where to add snippet so just opened command palette with cmd+shift+p and found Open User Settings (json) and then added snippet.
Also must be a small typo but i dont think json is meant to be after the "```"
docs/development/SETUP.md
Outdated
| Ensure ESLint is set as the default formatter: | ||
| ```json | ||
| "editor.defaultFormatter": "dbaeumer.vscode-eslint" | ||
| ``` |
There was a problem hiding this comment.
| Ensure ESLint is set as the default formatter: | |
| ```json | |
| "editor.defaultFormatter": "dbaeumer.vscode-eslint" | |
| ``` | |
| Set ESLint as the default formatter: | |
| **Using Settings UI**: Open the Command Palette (Cmd+Shift+P or Ctrl+Shift+P), select Preferences: Open Settings (UI), search "default formatter," and select ESLint. | |
| **Using JSON**: Open Preferences: Open User Settings (JSON) and add: | |
| ` "editor.defaultFormatter": "dbaeumer.vscode-eslint"` |
There was a problem hiding this comment.
Thanks @sandrahoang686 ! Do you think adding more detailed instructions would help? I did not want to go too much into vs code specifics, as people may be using different editors. Maybe with the updated note below, we don't need to change anything here at all? Let me know what you think!
There was a problem hiding this comment.
yeah I think that helps! thanks for working on this & updating 🙇🏼♀️
Related Ticket: #1263
Description of Changes
Developers should configure their IDEs or text editors to automatically format code on save.
This ensures code is consistently styled as per project standards before it even reaches version control.
This adds documentation in SETUP.md on how to configure format-on-save for VS Code.
Validation / Testing
Follow the steps described in the SETUP.md. Confirm that everything formats as expected.